
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>bent_plume_model.Model.save_txt &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="bent_plume_model.Model.simulate" href="bent_plume_model.Model.simulate.html" />
    <link rel="prev" title="bent_plume_model.Model.save_sim" href="bent_plume_model.Model.save_sim.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="bent-plume-model-model-save-txt">
<h1>bent_plume_model.Model.save_txt<a class="headerlink" href="#bent-plume-model-model-save-txt" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="bent_plume_model.Model.save_txt">
<code class="sig-prename descclassname">Model.</code><code class="sig-name descname">save_txt</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">base_name</em>, <em class="sig-param">profile_path</em>, <em class="sig-param">profile_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/bent_plume_model.html#Model.save_txt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bent_plume_model.Model.save_txt" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the state space in ascii text format for exporting</p>
<p>Save the state space (dependent and independent variables) in an
ascii text file for exporting to other programs (e.g., Matlab).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>base_name</strong><span class="classifier">str</span></dt><dd><p>Base file name for the output file.  This method will append the
.txt file extension to the data output and write a second file
with the header information called base_name_header.txt.  If the
particles that left the plume were tracked in the farfield, it
will also save the trajectory of those particles as
base_name_nnn.txt (output data) and base_name_nnn_header.txt
(header data for far field data).</p>
</dd>
<dt><strong>profile_path</strong><span class="classifier">str</span></dt><dd><p>String stating the file path to the ambient profile data relative
to the directory where <cite>fname</cite> will be saved.</p>
</dd>
<dt><strong>profile_info</strong><span class="classifier">str</span></dt><dd><p>Single line of text describing the ambient profile data.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="bent_plume_model.Model.save_sim.html#bent_plume_model.Model.save_sim" title="bent_plume_model.Model.save_sim"><code class="xref py py-obj docutils literal notranslate"><span class="pre">save_sim</span></code></a>, <a class="reference internal" href="bent_plume_model.Model.load_sim.html#bent_plume_model.Model.load_sim" title="bent_plume_model.Model.load_sim"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_sim</span></code></a>, <a class="reference internal" href="../spm/stratified_plume_model.Model.save_txt.html#stratified_plume_model.Model.save_txt" title="stratified_plume_model.Model.save_txt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stratified_plume_model.Model.save_txt</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="../sbm/single_bubble_model.Model.save_txt.html#single_bubble_model.Model.save_txt" title="single_bubble_model.Model.save_txt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">single_bubble_model.Model.save_txt</span></code></a></dt><dd></dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>The output will be organized in columns, with each column as follows:</p>
<blockquote>
<div><p>0   : time (s)
1-n : state space</p>
</div></blockquote>
<p>The header to the output file will give the extact organization of
each column of the output data.</p>
<p>These output files are written using the <cite>numpy.savetxt</cite> method.</p>
<p>Note, also, that this only saves the state space solution, and the
data saved by this function is inadequate to rebuild the <cite>Model</cite>
object by reloading a saved solution.  To have seamless saving and
loading of <cite>Model</cite> objects, use the <cite>save_sim</cite> and <cite>load_sim</cite>
commands.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/bpm.html">Overview of Bent Plume Model Module</a><ul>
  <li><a href="bent_plume_model.Model.html">bent_plume_model.Model</a><ul>
      <li>Previous: <a href="bent_plume_model.Model.save_sim.html" title="previous chapter">bent_plume_model.Model.save_sim</a></li>
      <li>Next: <a href="bent_plume_model.Model.simulate.html" title="next chapter">bent_plume_model.Model.simulate</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/bpm/bent_plume_model.Model.save_txt.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>